Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / AbstractFolder Class / MoveFilesTo Method / MoveFilesTo(AbstractFolder,Boolean,Boolean,Object[]) Method
An AbstractFolder object into which the folder's content must be moved. Cannot be NULL.
true if the content of the folders contained in the subfolders should be moved; false if only the current folder's content should be moved.
true if existing files in the destination should be replaced; false otherwise.
An array of objects that can be used to filter the items to be moved.


In This Topic
    MoveFilesTo(AbstractFolder,Boolean,Boolean,Object[]) Method
    In This Topic
    Moves the folder's content to another folder.
    Syntax
    'Declaration
 

    Public Overloads Sub MoveFilesTo( _
   ByVal destinationFolder As AbstractFolder, _
   ByVal recursive As Boolean, _
   ByVal replaceExistingFiles As Boolean, _
   ByVal ParamArray filters() As Object _
) 
    'Usage
 

    Dim instance As AbstractFolder
Dim destinationFolder As AbstractFolder
Dim recursive As Boolean
Dim replaceExistingFiles As Boolean
Dim filters() As Object
 
instance.MoveFilesTo(destinationFolder, recursive, replaceExistingFiles, filters)
    public void MoveFilesTo( 
   AbstractFolder destinationFolder,
   bool recursive,
   bool replaceExistingFiles,
   params object[] filters
)

    Parameters

    destinationFolder
    An AbstractFolder object into which the folder's content must be moved. Cannot be NULL.
    recursive
    true if the content of the folders contained in the subfolders should be moved; false if only the current folder's content should be moved.
    replaceExistingFiles
    true if existing files in the destination should be replaced; false otherwise.
    filters
    An array of objects that can be used to filter the items to be moved.
    Remarks

    If the physical folder specified by destinationFolder does not exist, it is created.

    The difference between MoveFilesTo() and MoveItemsTo() is how empty sub-folders are handled. MoveFilesTo() only includes files and files found in sub-folders in the move operation while MoveItemsTo() includes empty sub-folders in the move operation. Unless you specifically want to move empty folders, it is best to use MoveFilesTo().

    The folder's content (files and subfolders) that matches the provided filters is immediately moved to the destination.

    When replacingExistingFiles is true, any file in the destination that has the same name as a file being moved is automatically replaced.

    When replacingExistingFiles is false, an exception is thrown whenever the destination contains a file with the same name as a file being moved.

    To filter a list of files or folders, you can pass a variable number of objects in the filters parameter. These objects may be of the following types:

    Object type Type of filter applied
    System.String The string is assumed to be a file mask, and a NameFilter object is automatically created for the passed string, with FilterScope.File as the default FilterScope.
    System.IO.FileAttributes A AttributeFilter object is automatically created for the provided attributes, with FilterScope.File as the default FilterScope.
    Filter The provided Filter object is used as-is.
    Array of System.Object Each object in the array may be of the types described in this table, and is used accordingly.
    Other If any other type is found, an exception is thrown.

    FileSystemItem.ApplyPropertiesTo is called on the destination items; therefore, the attributes and dates of the original items are applied to the destination items.

    Supported Frameworks
    destinationFolderfiltersreplacingExistingFiles
    See Also

    Reference

    AbstractFolder Class
    AbstractFolder Members
    Overload List
    System.String
    NameFilter Class
    File Field
    System.IO.FileAttributes
    AttributeFilter Class
    File Field
    Filter Class
    Filter Class
    System.Object
    ApplyPropertiesTo(FileSystemItem) Method

    Send Feedback